Your suggested change has been received. Thank you.

close

Suggest A Change

https://thales.na.market.dpondemand.io/docs/dpod/services/kmo….

back

Tokens

Import YubiKey tokens

search

Import YubiKey tokens

Import YubiKey tokens

To import YubiKey tokens, use the YubiKey Personalization Tool, which is available from Yubico.

The YubiKey Personalization Tool is a Yubico product and is not developed by Thales Group. All questions or feedback regarding the tool and its documentation should be addressed with Yubico.

Import YubiKey tokens into STA, so that they become available to assign to users.

To import YubiKey tokens, perform these two steps:

  1. In the YubiKey Personalization Tool, create a token seed file.

  2. On the STA Token Management console, import that token seed file.

Create a YubiKey token seed file

Use the YubiKey Personalization Tool to create a token seed file for YubiKeys that are programmed in Open Authentication Initiative HMAC-based One-Time Password (OATH-HOTP) mode. OATH-HOTP is a standard algorithm for calculating one-time passwords based on a secret (a seed value) and a counter. The token seed file includes the core token data, such as the OATH seed value and the programmed counter value.

In the YubiKey Personalization Tool, the logging settings define the output format of the token seed file. To output a file that is suitable for importing into STA, the log configuration output should be in PSKC format.

After you create the token seed file, you import it on the STA Token Management console, so that the tokens become available to assign to users.

Refer to the Yubico documentation for information about the all of the available settings.

Configure the YubiKey settings

  1. In the YubiKey Personalization Tool, select Settings.

    alt_text

  2. To ensure compatibility with all applications, in the Output Format settings, verify that the Tab or Enter keystrokes are NOT selected.

    When a Tab or Enter keystroke is selected, the button has a blue background.

    The output format specifies how the OTP is sent from the YubiKey. Tab keystrokes move the cursor to the next input field, and the Enter key sends the OTP code + Enter.

  3. In the Logging Settings, select the Log configuration output check box, and select PSKC format in the list.

    The logging settings allow you to record the OATH-HOTP parameters that are used for programming the YubiKey in a token seed file, and to specify the format of the data in the token seed file. The log output is a token seed .csv file that is suitable for importing into STA.

Program the YubiKey in OATH-HOTP mode

There are two options for configuring the YubiKey in OATH-HOTP mode:

  • Quick: Program the YubiKey in OATH-HOTP mode using default parameters.

  • Advanced: Program the YubiKey in OATH-HOTP mode using your own parameters.

Quick OATH-HOTP mode

  1. In the YubiKey Personalization Tool, select OATH-HOTP or OATH-HOTP Mode.

  2. Select Quick, and insert a YubiKey into a USB port on your computer.

    alt_text

  3. Select the Configuration Slot. Typically, Configuration Slot 1 is used.

    The availability of slots depends on the token type. Consult your YubiKey token guide for the correct slot.

  4. Clear the OATH Token Identifier check box, so that the YubiKey doesn't output the OATH Token Identifier.

  5. Select Write Configuration, to write to the token and create the token seed file that you can import in STA.

    The .csv file that is generated by default is actually a PSKC file that you subsequently import into STA.

  6. Open the .csv file and ensure that there is a closing </KeyContainer> tag at the end. Add the closing tag if it is missing.

    For example: 

    alt_text

Advanced OATH-HOTP

  1. In the YubiKey Personalization Tool, select OATH-HOTP or OATH-HOTP Mode.

  2. Select Advanced, and insert a YubiKey into a USB port on your computer.

    alt_text

  3. Select the Configuration Slot. Typically, Configuration Slot 1 is used.

    The availability of slots depends on the token type. Consult your YubiKey token guide for the correct slot.

  4. In the OATH-HOTP Parameters section, clear the OATH Token Identifier check box, so that the YubiKey doesn't output the OATH Token Identifier.

  5. For the Secret Key, select Generate.

  6. Modify the other settings as required.

  7. Select Write Configuration, to write to the token and create the token seed file that you can import in STA.

    The .csv file that is generated by default is actually a PSKC file that you subsequently import into STA.

  8. Open the .csv file and ensure that there is a closing </KeyContainer> tag at the end. Add the closing tag if it is missing.

    For example: 

    alt_text

Import the YubiKey token seed file and test a token

Import the YubiKey PSKC-formatted token seed file that you created in the YubiKey Personalization Tool, so that the YubiKey tokens become available to assign to users.

  1. On the STA Token Management console, select the Tokens tab and expand the Import SafeNet Tokens module.

    alt_text

  2. In the Import File field, browse to the Yubikey token seed file (.csv file), and then select Import.

  3. To view the list of imported tokens, select the Tokens tab and expand the Tokens module.

  4. Select eToken in the Token Type list, and select Search.

    alt_text

  5. In the Token List, select a token Serial # to view the details.

    alt_text

  6. Test a Yubikey token:

    1. Assign a Yubikey token to a test user.

    2. Go to the User Portal or the Self-Service site.

      • To find the User Portal URL, on the STA Access Management console, select Applications > User Portal.

      • To find the Self-Service site URL, on the STA Token Management console, select Self-Service > Configuring Self-Service > Self-Service Policy.

    3. Log in with the User ID and the Yubikey that you assigned.

      • To use slot 1 to enter an OTP, place the cursor in the OTP field and touch the capacity sensor on the token.

      • To use slot 2 to enter an OTP, place the cursor in the OTP field and touch the capacity sensor on the token for at least 3 seconds.

  7. After you verify that the Yubikey token works, revoke the token from the test user.

  8. Assign the Yubikey tokens to users.